/* Copyright 2009 Sony Mathew, Minneapolis MN. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. */
package com.xsm.lite.event;


/**
 * A Tagging base class for RemoteControl stereotypes which handle/process User driven actions represented as Events.
 * 
 * @author Sony Mathew
 */
public abstract class RemoteControl implements Event.Listener, RequestEvent.Processor {

    /**
     * The IoC Context of this RemoteControl, subclass Contexts should extend it.
     */
    public interface Context {
        public EventManager getEventManager();
    }
    
    private final Context cxt;
    
    /**
     * author Sony Mathew
     */
    public RemoteControl(Context cxt) {
        this.cxt = cxt;
    }
            
    /**
     * Convenience method to fire an event using the EventManager.
     * 
     * author Sony Mathew
     */
    protected void fire(Event e) {
        cxt.getEventManager().fire(e);
    }
    
    /**
     * Convenience method to add myself as a Listener for the given eventClass.
     * You still need to implement the Event specific Listener.
     *  
     * author Sony Mathew
     */
    protected void listen(Class<? extends Event> eventClass) {
        cxt.getEventManager().addListener(eventClass, this);
    }
    

    /**
     * Convenience method to add myself as a Processor for the given eventClass.
     * You still need to implement the Event specific Processor.
     *  
     * author Sony Mathew
     */
    protected void process(Class<? extends RequestEvent> eventClass) {
        cxt.getEventManager().addProcessor(eventClass, this);
    }

}
